Web5 SDK Documentation/web5.sdk.credentials.model

Package-level declarations

Types

enum ConformantConsumerDisclosure : Enum<ConformantConsumerDisclosure>

Enumeration representing consumer disclosure options. Represents the possible values of `limit_disclosure' property as defined in Input Descriptor

ConstraintsV2

class ConstraintsV2(val fields: List<FieldV2>? = null, val limitDisclosure: ConformantConsumerDisclosure? = null)

Represents constraints for an input descriptor.

FieldV2

class FieldV2(val id: String? = null, val path: List<String>, val purpose: String? = null, filterJson: <Error class: unknown class>? = null, val predicate: Optionality? = null, val name: String? = null, val optional: Boolean? = null)

Represents a field in a presentation input descriptor.

FieldV2Validator

object FieldV2Validator

FieldV2Validator Validator.

Format

class Format(val jwt: JwtObject? = null, val jwtVc: JwtObject? = null, val jwtVp: JwtObject? = null)

Represents the format of a presentation definition.

InputDescriptorMapping

class InputDescriptorMapping(val id: String, val format: String, val path: String, val pathNested: InputDescriptorMapping? = null)

Represents descriptor map for a presentation submission.

InputDescriptorV2

class InputDescriptorV2(val id: String, val name: String? = null, val purpose: String? = null, val format: Format? = null, val constraints: ConstraintsV2)

Represents an input descriptor in a presentation definition.

InputDescriptorV2Validator

object InputDescriptorV2Validator

InputDescriptorV2Validator Validator.

JwtObject

class JwtObject(val alg: List<String>)

Represents a JWT object.

Optionality

enum Optionality : Enum<Optionality>

Enumeration representing optionality.

PresentationDefinitionV2

class PresentationDefinitionV2(val id: String, val name: String? = null, val purpose: String? = null, val format: Format? = null, val submissionRequirements: List<SubmissionRequirement>? = null, val inputDescriptors: List<InputDescriptorV2>)

Presentation Exchange

PresentationDefinitionV2Validator

object PresentationDefinitionV2Validator

PresentationDefinitionV2Validator Validator.

PresentationSubmission

class PresentationSubmission(val id: String, val definitionId: String, val descriptorMap: List<InputDescriptorMapping>)

Represents a presentation submission object.

PresentationSubmissionValidator

object PresentationSubmissionValidator

PresentationSubmission Validator.

Rules

enum Rules : Enum<Rules>

Enumeration representing presentation rule options.

SubmissionRequirement

class SubmissionRequirement(val name: String? = null, val purpose: String? = null, val rule: Rules, val count: Int? = null, val min: Int? = null, val max: Int? = null, val from: String? = null, val fromNested: List<SubmissionRequirement>? = null)

Represents submission requirements for a presentation definition.